home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / cl14s23b.zip / CONFIG.DOC < prev    next >
Text File  |  1992-04-15  |  31KB  |  651 lines
  1. Since I added alot of entries to the CALLS.CNF file, I thought it was time
  2. I wrote a document to explain them in more detail. I will also give you an
  3. explination of the entries that Sam Smith created.
  4.  
  5. Almost all entries have a default value and if there is not an entry or you
  6. comment out the entry then the default will be used. The entries may be made
  7. in any order you like and if you duplicate one, the last one will be the one
  8. to take affect.
  9.  
  10. *---------------------------------------------------------------------------
  11. ;full name of caller input file (or NUL) - Default = CALLER
  12. INFILE  C:\PCB\MAIN\CALLER
  13.  
  14. This is the file to be read and processed. If you are running a single node
  15. and specify NODE 1 then this will be the complete filename used. If you
  16. specify NODE 2 (or higher) then CALLS.EXE will append a '1' to the filename
  17. and process that file, then append a '2' and process that, etc.. until it
  18. has processed all CALLER files uo to the value you assign to NODE.
  19.  
  20.  
  21. *---------------------------------------------------------------------------
  22. ;output file to produce - Default = BLT99
  23. OUTFILE C:\PCB\GEN\BLT11
  24.  
  25. This is the file to send the output to. If you specify BOTH or ANSI for
  26. REPORTTYPE then a 'G' will be appended to the filename and an ANSI report
  27. generated. If you use a full 8 character filename then when the 'G' gets
  28. appended DOS will still interpet the same filename and you will only get 1
  29. report in ASCII if you specified BOTH unless you specify a '.' at the end
  30. of the filename in which case CALLS.EXE can properly append a 'G' to it.
  31.  
  32. *---------------------------------------------------------------------------
  33. ;input file of a Header to precede report - Default = NUL
  34. HEADER C:\PCB\GEN\BLT11.HD
  35.  
  36.  
  37. This file (if it is found to exist) will be read just prior to outputing
  38. the report and will be output to the report. It will be output just after
  39. the @CLS@ if you have a '*' as the first character of REPORTS. If you
  40. specify ANSI or BOTH then a 'G' will be appended to the filename and be
  41. used for the ANSI version of the output (note the same notes regarding
  42. the appending as above). If the 'G' version does not exist, then no header
  43. will be used for the ANSI version.
  44.  
  45. *---------------------------------------------------------------------------
  46. ;file for saved history information (or NUL) - Default = CALLS.SAV
  47. SAVEFILE CALLS.SAV
  48.  
  49. If not set to NUL, then this file will be read before beginning the processing
  50. of the INFILE(s) and saved after writing the OUTFILE. This allows reading
  51. the CALLERS file each day and then discarding it. The totals will be
  52. accumulated in CALLS.SAV each time. Also if you like seperate bulletins to
  53. be generated for the different reports, you can have multiple .CNF files and
  54. in the first specify an INFILE and a SAVEFILE and the first OUTFILE. Then
  55. in additional .CNF files set for different REPORTS, you can specify NUL for
  56. INFILE to indicate no file processing be done, and reports wil be generated
  57. from the totals in the SAVEFILE which allows for quick generation of reports.
  58. Change the OUTFILE for each report to be generated.
  59. *---------------------------------------------------------------------------
  60. ;file for outputting any unknown line for study (or NUL) - Default = NUL
  61. UNKNOWNFILE UNKNOWN.TXT
  62.  
  63. This file is for troubleshooting and was used by me in generating data. It
  64. allows for sending certain lines read to a file given the following conditions:
  65.  
  66. *-----
  67. ;include all unknown lines in unknown file - Default = YES
  68. UNKNOWNREPORT YES
  69.  
  70. Any line that is not specifically recogonized by CALLS.EXE for processing will
  71. be dumped to the file specified in UNKNOWNFILE. This allows recoginizing what
  72. changes might need to be made to CALLS.EXE for future enhancements. It can
  73. also allow you to spot errors in setup. I intentionally do not recoginze
  74. certain error messages that PCBoard generates, so if they pop up in the
  75. UNKNOWNFILE I can see them right away, whereas I might miss them when checking
  76. the CALLERS file.
  77.  
  78. *-----
  79. ;include all Junk lines in unknown file - Default = NO
  80. ;junk lines are those recognized by CALLS and skipped over.
  81. JUNKREPORT YES
  82.  
  83. Certain line are recognized by CALLS.EXE but not processed in anyway. They are
  84. only recoginized to prevent them from being written to UNKNOWNFILE. If you want
  85. to see what they are, set this to YES. If there is some data that you feel
  86. should be reported in some useful way, let me know.
  87.  
  88. *-----
  89. ;include all Catchall lines in unknown file - Default = NO
  90. ;Catchall lines are those recognized by CALLS in the Catchall routine which
  91. ;picks up lines missed by the normal scan (some just have to be done this way)
  92. CATCHALLREPORT YES
  93.  
  94. Some lines (like conferences joined) just had to pass thru the catchall
  95. routine. Those that had to pass that way will not reported by setting this
  96. to YES. Others that were in the routine, that I could not figure out why they
  97. were there as they were already trapped for previously, will be reported if
  98. this is set to YES and they get caught in the CATCHALL routine. If they don't
  99. don't ever show up then I will remove those lines of code.
  100.  
  101. The way processing is done in order to speed up the recognition of the lines
  102. is to first process the first (position 7) character of the line and then
  103. scan for data in in a CASE statement based on the first character, if the
  104. line is not recognized then it passes to the CatchAll routine. This is
  105. conferences joined have to be caught in the catchall routine. The conference
  106. name is the first thing on the line so the first letter could be anything.
  107.  
  108. *-----
  109. ;include all Door lines in unknown file - Default = NO
  110. DOORREPORT NO
  111.  
  112. If set to YES then everything from the OPENED DOOR (xxxxx) AT HH:MM to
  113. the BACK TO DOS AT HH:MM will be sent to the UNKNOWNFILE (if the line is
  114. unrecognized then it will be echoed twice if UNKNOWNREPORT is set to YES).
  115. This allows for troubleshooting the door reports or gathering info for
  116. building your own report.
  117.  
  118. *---------------------------------------------------------------------------
  119. ;number of nodes to scan (1=single node mode) - Default = 1
  120. NODES   1
  121.  
  122. This is the number of nodes that you want to scan and will cause a number
  123. to be appended to the INFILE name and each file ot be processed in sequence
  124. as described under INFILE. If you only run a single node then set this to 1.
  125. If you run a single node but have PCBoard set for multiple nodes so that the
  126. CALLER file is named CALLER1 then you will need to specify CALLER1 under
  127. OUTFILE and set NODE to 1.
  128.  
  129.  
  130. *---------------------------------------------------------------------------
  131. ;list of nodes (in order of desired scan, NODES should equal the number of
  132. ;nodes included in the list. If no list provided then all nodes will be
  133. ;scanned from 1 to NODES)
  134. ;NODES 3
  135. ;NODELIST 5 3 1
  136.  
  137. This allows you more control over scanning multi-node setups. You can easily
  138. scan only some of your nodes without having to run the program several times
  139. using a CALLS.SAV file to collect the data. Try to make sure that NODES matches
  140. the number of of entries in the list, although provisions have been made to
  141. ensure that CALLS will not care. If there are more entries they will be
  142. ignored, and if there are less entries CALLS just ignore the fact, just by
  143. being careful, you will save yourself some headaches trying to figure out why
  144. some nodes don't show up.
  145.  
  146.  
  147. *---------------------------------------------------------------------------
  148. ;list of reports to produce from the following list
  149. ; Default = ANSTBCXO!RPDEVU^-F=GY1Y2Y3Y4Y5Y6Y7Y8#HIJKLQ&M
  150. ;
  151. ;   A - system statistics            B - graphic modes
  152. ;   C - baud rates                   D - hourly usage
  153. ;   E - conferences joined           F - bulletins read
  154. ;   G - doors opened                 H - download protocols
  155. ;   I - download efficiency          J - upload protocols
  156. ;   K - upload efficiency            L - batch sizes
  157. ;   M - files downloaded             N - security statistics
  158. ;   O - security level counters      P - connect type analysis
  159. ;   Q - free downloads *Not PCB*     R - Minutes used by Security
  160. ;   S - Sysop Statistics             T - User Statistics
  161. ;   U - User Messages                V - Conf Messages
  162. ;   W - Event Report                 X - Language Report
  163. ;   Y - Door Report                  Z - insert a blank line
  164. ;   @ - insert a @MORE@ prompt       $ - insert a @PAUSE@ prompt
  165. ;   % - insert a @WAIT@ prompt       * - insert a @CLS@
  166. ;   ! - Last Called In Report        # - Message Statistics
  167. ;   = - Time Spent in Doors Report   ^ - User Uploads
  168. ;   - - Callers Hanging Up           & - Caller ID Report
  169. ;
  170. ; Door Reports are followed by number
  171. ;   1 - InstaReg                     2 - PCBVerify
  172. ;   3 - Callback                     4 - Depository
  173. ;   5 - MailDoor (Generic)           6 - QMail
  174. ;   7 - MarkMail                     8 - User Definable
  175. ;
  176. REPORTS *ANZSTZBCDXO!RPEVU^-F=GY1ZY2Y3ZY4Y5ZY6Y7ZY8#HIJKL&MW%
  177.  
  178. This controls which reports and in which order they will be issued to the
  179. OUTFILE. If a '*' is placed as the first character then a @CLS@ will be sent
  180. to the OUTFILE before anything else. Each character controls a single report
  181. except for Y which requires two characters (Y1 ... Y8).
  182.  
  183. *---------------------------------------------------------------------------
  184. ;Exclude accumulation of Data for graph reports - Default - None
  185. ;Allowable entries are (CEFLOPQRUVWXY!=^-&)
  186. ;REPORTEXCLUDE Y
  187.  
  188. This allows you to prevent the collection of data which you will not be using
  189. which can offer a slight speed improvement and most importantly, reduce the
  190. size of the SAVEFILE when accululating data over long periods of time. Note:
  191. If you exclude any report data, then it will not be accumlated and saved in
  192. the SAVEFILE and you will not be able to report on it in the future without
  193. rescanning old CALLER files.
  194.  
  195. *---------------------------------------------------------------------------
  196. ;Action to perform after each section
  197. ;Allowable entries are (Z@$%*)
  198. REPORTACTION Z%*
  199.  
  200. After every report control character in REPORTS, the string in REPORTACTION
  201. will be processed UNLESS the next character in REPORTS is one of the
  202. characters (Z@$%*.) in which case REPORTACTION will not be processed for that
  203. report. This allows you to perform a @WAIT@ and @CLS@ after EVERY report, yet
  204. prevent the action from occuring on certain reports that you want to combine.
  205. The '.' is a do nothing character that is used to stop the REPORTACTION without
  206. the need to do anything else. The others are described in REPORTS.
  207.  
  208. *---------------------------------------------------------------------------
  209. ;Type of report to output, ASCII, ANSI, BOTH or PCBOARD - Default - BOTH
  210. REPORTTYPE PCBOARD
  211.  
  212. This allows you to control what type of report format you output. ASCII is
  213. a straight text file. ANSI is a colorized version using ANSI escape sequences,
  214. and a 'G" is appended to the OUTFILE and HEADER filenames. BOTH will cause
  215. both an ASCII and ANSI report. A setting of PCBOARD will cause a single report
  216. (with no 'G' appended to filenames) to be output using @Xnn color codes.
  217. In all cases the reports will be generated with @MORE@, @PAUSE@ and @WAIT@
  218. prompts if the are specified. For ASCII and PCBOARD, a @CLS@ will be used but
  219. for ANSI a <ESC>[2J sequence will be issued.
  220.  
  221. *---------------------------------------------------------------------------
  222. ;peak hours to report
  223. ;                 1         2
  224. ;       012345678901234567890123
  225. PEAK    YNNNNNNNNNNNNNNNNYYYYYYY
  226.  
  227. This will be used to control which times are used when calcluating the
  228. Peak Utilization %...    xx.x line. The hours marked with a 'Y' will be
  229. included in the peak calculation.
  230.  
  231. *---------------------------------------------------------------------------
  232. ;shorten graph to just percentage used - Default = no
  233. ;NO/YES/or the minumum percent to start at
  234. SHORTENGRAPH 50
  235.  
  236. If set to NO the the full hourly usage chart will be generated. If set to YES
  237. then only the portion that is needed (the maximum usage) will be generated.
  238. If set to a value (0 to 100 in multiples of 5) then either the maximum usage
  239. or the value set will be generate, which ever is higher. This allows you to
  240. limit the number of blank lines that are generated by keeping the report to
  241. just those lines needed without shrinking the report too small to look good.
  242.  
  243. *---------------------------------------------------------------------------
  244. ;full name of Sysop or SYSOP
  245. SYSOPNAME GARY MEEKER
  246.  
  247. This allows CALLS.EXE to recoginze you as the SYSOP when reporting local or
  248. remote Sysop sessions. If you have PCBoard use your name then place that here
  249. or if you have it use SYSOP then specify SYSOP here.
  250.  
  251. *---------------------------------------------------------------------------
  252. ;First Name to Exclude from stats (RNET.EXE is always excluded)
  253. ; up to 10 entries are allowed (this is not for USER names!)
  254. ;EXCLUDENAME RNET.EXE
  255.  
  256. This allows you to specify program names that generate logons that look just
  257. like a User from being incuded in the report or prematurely stopping the
  258. event timing. RNET.EXE is one such example is is already handled by CALLS.EXE
  259. and need not be specified here. You can have up to 10 entries and more will
  260. be ignored.
  261.  
  262. *---------------------------------------------------------------------------
  263. ;Full User Name to exclude from stats (Conference Messages Left,
  264. ; Uploads and Caller Hungup Reports). Up to 50 entries are allowed.
  265. ; Adding '*' as first character of name will flag User as a NetUser.
  266. ;EXCLUDEUSER GARY MEEKER
  267.  
  268. This allows you to exclude Users from being included in the reports mentions
  269. above. If you are a HUB then you can include your NODE names from these
  270. reports or exclude yourself if you like. Flagging a User as a NetUser will
  271. cause messages left by this User to count as Net Mail instead of Mail Door
  272. messages. If NetUser is flagged and a message is left via PCBoard instead
  273. of a Door then the User Name will NOT be excluded and it will not count as
  274. Net Mail.
  275.  
  276.  
  277. *---------------------------------------------------------------------------
  278. ;Door to exclude from stats (Doors Opened and Time Spent in Doors)
  279. ; Up to 50 entries are allowed.
  280. EXCLUDEDOOR REMOTE
  281.  
  282. This allows you to exclude Doors form being included in the reports.
  283.  
  284.  
  285. *---------------------------------------------------------------------------
  286. ;Label given to the Doors that are excluded. - Default = Unlisted
  287. ;NONDOORNAME Unlisted
  288.  
  289. All Excluded Doors are counted and Timed but are reported as a single entry.
  290. This variable allows defining that label. If set to a blank then they will
  291. not be reported and not added to the SaveFile at all.
  292.  
  293.  
  294. *---------------------------------------------------------------------------
  295. ;Area Code for CALLER ID Report. If matched then is considered a Local Call.
  296. AREACODE 404
  297.  
  298. This is used in the Caller ID report. If the Area Code matches the one defined
  299. here, then the ID will be listed as a local call. Otgerwise, it will be listed
  300. as a long distance call.
  301.  
  302. *---------------------------------------------------------------------------
  303. ;Save filenames & counts in the history information file YES (default) or NO
  304. FILENAMES YES
  305.  
  306. If you don't wish to report files downloaded then you can save alot of file
  307. space in the SAVEFILE by setting this to NO.
  308.  
  309. *---------------------------------------------------------------------------
  310. ;File mask of files to be ignored completely, wildcards allowed
  311. ; up to 10 entries are allowed (wildcard '#' matches any digit)
  312. FILTERFILES *.GIF
  313. FILTERFILES *.TIF
  314. FILTERFILES *.PIC
  315. FILTERFILES #####?.ZIP
  316. FILTERFILES #####?.CAP
  317.  
  318. This allows preventing unwanted or sensitive filenames from being included
  319. in the files downloaded report. Wildcards are allowed and a special wildcard
  320. of '#' allows matching any digit to allow for filtering out .CAP files when
  321. using the Caller Number as the filename. They wouldn't show up in the report
  322. unless the same file was downloaded more than once (unlikely, unless you
  323. reset the Caller Number, but why include them in the total or SAVEFILE).
  324. Only 50 are provided for but if more are needed, let me know and I will
  325. increase that.
  326.  
  327. *---------------------------------------------------------------------------
  328. ;number of "User Messages Left" to report
  329. MAXUSERS 30
  330.  
  331. ;number of "User Uploads" to report
  332. MAXUL 30
  333.  
  334. ;number of "Callers Hanging Up" to report
  335. MAXHANGUP 30
  336.  
  337. ;number of "Conference Messages Left" to report
  338. MAXMSGS 20
  339.  
  340. ;number of "free downloads" to report
  341. MAXFREE 10
  342.  
  343. ;maximum number of conferences to report
  344. MAXCONF 20
  345.  
  346. ;maximum number of bulletins to report
  347. MAXBLT  20
  348.  
  349. ;maximum number of doors to report
  350. MAXDOOR 20
  351.  
  352. ;maximum number of batch sizes to report
  353. MAXBATCH 5
  354.  
  355. These control how many entries are to be reported in each report. If specified
  356. then the report will show Top xx in the report header. If not specified then
  357. all entries will be reported.
  358.  
  359. *---------------------------------------------------------------------------
  360. ;minimum d/l's to include a file in report
  361. MINDL   2
  362.  
  363. This will control which filename get reported in the Files downloaded report.
  364. Only files downloaded as many or more times as the number specified here will
  365. be reported.
  366.  
  367. *---------------------------------------------------------------------------
  368. ;redefine protocol names
  369.  
  370. PROTOCOL A Ascii (Non-Binary)
  371. PROTOCOL X Xmodem (Checksum)
  372. PROTOCOL C Xmodem (CRC)
  373. PROTOCOL O 1K-Xmodem (Ymodem)
  374. PROTOCOL F 1K-Xmodem-G(Ymodem/G)
  375. PROTOCOL Y Ymodem  (PCB Batch)
  376. PROTOCOL G Ymodem/G(PCB Batch)
  377. PROTOCOL D Ymodem  (DSZ Batch)
  378. PROTOCOL H Ymodem/G(DSZ Batch)
  379. PROTOCOL Z Zmodem  (DSZ Batch)
  380. PROTOCOL N None
  381.  
  382. This allows you to specify the Text Name used in the report for each PROTOCOL.
  383. The leter following the PROTOCOL matches that of the associated Protocol you
  384. have defined in PCBoard.
  385.  
  386. *---------------------------------------------------------------------------
  387. ;Text to be added before the Security Level - Default = Level
  388. SECLABEL Security Level
  389.  
  390. This allows you to define what text is added to the security level for the
  391. report lines. If you want just the Security level with no other text, then
  392. just include the line SECLABEL with no text after it.
  393.  
  394. *---------------------------------------------------------------------------
  395. ;Text to be added before the Security Level - Default = ''
  396. ;if blank then line will not be printed
  397. NOSECLABEL No Security Level
  398.  
  399. This allows you to define what text is used to report caller entries with
  400. no security level. If undefined or defined as NOSECLABEL with no text after
  401. it, then this line will not be reported at all.
  402.  
  403. *---------------------------------------------------------------------------
  404. ;redefine Door Names   -  (I,V,C,D,G,Q,M,U)
  405. ;corresponds to report - Y(1,2,3,4,5,6,7,8)
  406. ;
  407. ; A '/' may be used to seperate Mulitple Door Names for the Same Door
  408. ;  (Note: No spaces allowed)     ie. DOOR I INSTAREG/RENEW
  409. ;
  410. DOOR I INSTAREG
  411. DOOR V VERIFY
  412. DOOR C CALLBACK
  413. DOOR D DEPOSIT
  414. DOOR G MAIL
  415. DOOR Q QMAIL4
  416. DOOR M MM2
  417. DOOR U REGISTER
  418.  
  419. This controls the processing of doors recoginzed specially by CALLS.EXE.
  420. The default names are shown above and if you run the door under a different
  421. name, you must specify that here or it will not be accumulated in the reports.
  422. If you run the same door under multiple names, then specify each name here
  423. seperated by a '/'.
  424.  
  425. *---------------------------------------------------------------------------
  426. ;Maximum item length for variable length items - Default = 20
  427. ; (variable length items are defined by ITEMLEN of -1)
  428. ;
  429. ;ITEMMAX 25
  430.  
  431. This controls the maximum length that will be used of a graph item when an
  432. ITEMLEN of -1 is specified for a report.
  433.  
  434. *---------------------------------------------------------------------------
  435. ;Item length for graphs, If set to -1 then will be set to longest item
  436. ;ITEMLEN C 10
  437. ;ITEMLEN P -1
  438.  
  439. This controls the length that will be used of a graph item. This allows
  440. reducing the wasted space on the shorter reports and increasing the length
  441. of the graph bars themselves. It also allows increasing the defaults so the
  442. entire User Name would show if one exceeds the 20 character limit normally
  443. set in CALLS. The defaults are all 20 except for:
  444.  
  445. 'C'                is   8
  446. 'G', 'L' and '='  are  10
  447. 'E', 'V' and '&'  are  15
  448.  
  449. The length used will actually be 1 less than set as there is 1 space at the
  450. front of all items. The parameter after the ITEMLEN is the Report Name as
  451. listed in REPORTS and the last parameter is the length to be set. Setting
  452. a value of -1 will cause the longest length encountered to be used as long
  453. as ITEMMAX is not exceeded.
  454.  
  455. *---------------------------------------------------------------------------
  456. ;Report Label for Generic Mail Door - Default = Your Mail Door
  457. ;Report Label for User Definable Mail Door - Default = Any Door
  458. ;REPORTTITLE A Here's a Title
  459. REPORTTITLE Y5 Cam-Mail Door
  460. REPORTTITLE Y8 Register Door
  461.  
  462. This allows you to redefine the Header text of any of the reports you would
  463. like to. If you want a more descriptive Header than provided, you can
  464. define your own.  The parameter after the REPORTTITLE is the Report Name
  465. as listed in REPORTS and the last parameter is the title to be set.
  466.  
  467. *---------------------------------------------------------------------------
  468. ;redefine User Definable Door Text - (1-20)
  469. ;DEFDOOR 1 FIND THIS TEXT
  470. ;
  471. ; If not defined then the entry will not be scanned for regardless of
  472. ; DEFDOORTYPE or DEFREPORT entry. If defined then the text will be
  473. ; scanned for anywhere in the line. Order of variables can be important.
  474. ;
  475. DEFDOOR 1 ADJUSTED
  476. DEFDOOR 2 CARRIER LOST
  477. DEFDOOR 3 KEYBOARD TIMEOUT
  478.  
  479. This allows you to define the text that is scanned for for a Door defined
  480. by yourself. This Door corresponds to the DOOR U DoorName entry (or REPORT
  481. Y8). You may define up to text entries to be recognized. Use as much or as
  482. little of the text you need to identify a particular line from another. The
  483. number corresponds to the 20 variables set aside for the door report. If the
  484. text you specify is found then the variable will be incremented. Undefined
  485. (unused) text entries will not be scanned for.
  486.  
  487. *---------------------------------------------------------------------------
  488. ;redefine User Definable Door Variable Type - (1-20)
  489. ;DEFDOORTYPE 1 1
  490. ;
  491. ; When DEFDOOR is defined:
  492. ; Bit 2 means Carrier lost, Doesn't count if Door Logged User Off
  493. ; Bit 4 means Door Logged User Off
  494. ; Bit 8 means Line contains HH:MM entry to stop Door Timing
  495. ;
  496. ; When DEFREPORT is NOT defined:
  497. ; Assigning a  1 means show '  .......................       '
  498. ; Assigning a -1 means show '                                '
  499. ;
  500. DEFDOORTYPE 1 1
  501. DEFDOORTYPE 2 2
  502. DEFDOORTYPE 3 1
  503.  
  504. This controls special aspects of the variables. It is 'bit' controlled and
  505. you can include all or none of the bits.  The bit meanings are described above.
  506. The real use is to recoginze a CARRIER LOS entry so it can be counted properly
  507. for the report. Also, if there is a line issued by the door that would indicate
  508. that the door was dropping carrier or loggin the user off, this prevents CALLS
  509. from counting a CARRIER LOST against the User. Allowance is also given to
  510. tell CALLS to stop timing the door on a given entry. One such line exists
  511. in PCBVerify as 'User disconnected at (HH:MM:SS)' so setting an entry to 12
  512. would cause CALLS to recoginze that timing of the door can stop and that
  513. a subsequent CARRIER LOST should be ignored (until a Minutes Used or a
  514. Back From Dos at HH:MM line appears to indicate the door data has ended.
  515.  
  516. If a variable is unused you can use DEFDOORTYPE to cause a blank line to
  517. be generated by setting as descibed above. This allows for flexible report
  518. output to be designed. Although only 1 User Definable report is allowed, you
  519. can combine multiple doors under it by defining DOOR U Door1/Door2/Door3
  520. and then using the first several variables for Door1, skip 2 variables, use
  521. some for Door2, skip 2 and then Use more for Door3. Setting the skipped
  522. variables DEFDOORTYPE to -1 will cause a seperating blankline. Only a single
  523. Number of times Door Opened, Time in Door, etc... report will be generated
  524. and represent all doors combined.
  525.  
  526. *---------------------------------------------------------------------------
  527. ;redefine User Definable Door Report Text - (1-20)
  528. ;DEFREPORT 1 Found the text
  529. ;
  530. ; If not defined then the entry will not be Reported, unless DEFDOORTYPE
  531. ; is defined in which case a blank entry will be reported.
  532. ;
  533. DEFREPORT 1 Security Level Adjusted
  534. DEFREPORT 2 Caller Dropped Carrier
  535. DEFREPORT 3 Keyboard Timeouts
  536.  
  537. This allows you to specify teh text that appears in the report itself for
  538. each variable. Blank (or unused) lines will not be printed (with the noted
  539. exception of the 1, -1 DEFDOORTYPE mentioned above)
  540.  
  541. *---------------------------------------------------------------------------
  542. ;Include Refused to Register and Access Denied - Refused Registration
  543. REFUSEDREG NO
  544.  
  545. This allows you to have the two figures combined and reported under Refused
  546. to Register. The purpose for this is for those of us who allow Users to
  547. remain on the BBS at a reduced level if they don't register. PCBoard generates
  548. a Refused to Register entry and CALLS uses that to generate a Non-Registered
  549. Users report. Only those Users who refuse to give a full name after starting
  550. a name entry or refuse to answer the questions after starting registration
  551. cause a Access Denied - Refused Registration wntry to be generated which CALLS
  552. uses to generate a Refused to Register report for. If you have the level set
  553. to 0 for these users, then PCBoard will kick them off and you will get a
  554. Refused to Register entry in the log for them. Setting REFUSEDREG YES will
  555. cause CALLS to report both entries under Refused to Register (although the
  556. entries will still be reported under Non-Registered Users also.)
  557.  
  558. *---------------------------------------------------------------------------
  559. ;redefine Language Names - 20 characters max - (1 - 30)
  560. ;LANGUAGE 5 Three Stooges    (5)
  561. LANGUAGE 1 English [Default](1)
  562. LANGUAGE 2 Southern Style   (2)
  563. LANGUAGE 3 Three Stooges    (3)
  564.  
  565. This allows you to define the name of the languges reported by CALLS to
  566. what you call them in PCBML.DAT file.
  567.  
  568. *---------------------------------------------------------------------------
  569. ;define how event time is reported
  570. ;   EVENTMODE OFF disables calculation of event duration.
  571. ;   EVENTMODE BUSY calculates event duration and accounts for it
  572. ;       as 'busy' time (i.e. the system was in use during this time).
  573. ;   EVENTMODE IDLE calculates event duration and accounts for it
  574. ;       as 'idle' time (i.e. the system was NOT in use during this time).
  575. EVENTMODE BUSY
  576.  
  577. This allows you to consder the BBS IDLE or BUSY during the time the Event is
  578. running.
  579. *---------------------------------------------------------------------------
  580. ;define how Sysop chat time is reported
  581. ;   CHATMODE OFF disables calculation of Sysop chat duration.
  582. ;   CHATMODE BUSY calculates Sysop chat duration and accounts for it
  583. ;       as 'busy' time (i.e. the system was in use during this time).
  584. ;   CHATMODE IDLE calculates Sysop chat duration and accounts for it
  585. ;       as 'idle' time (i.e. the system was NOT in use during this time).
  586. CHATMODE IDLE
  587.  
  588. This was intended to allow you to define the BBS IDLE or BUSY during the
  589. time the User was in Chat with the Sysop but it is not correct. It should
  590. be set to IDLE or the figures might not be correct. I added it as it is
  591. possible not to charge the User for time spent in chat but this really
  592. didn't affect the Minutes Used time reported in the Caller log, only how
  593. much time he was charged in the User file. I will probably remove this
  594. section at a later date or fix it to work by subtrating time if set to IDLE
  595. so when time is added at the minutes used line, it will have been cancelled
  596. out already. I also left it in as it does allow suppresion of the time in
  597. chat line if set to OFF
  598.  
  599. *---------------------------------------------------------------------------
  600. ;define how Node chat time is reported
  601. ;   NODEMODE OFF disables calculation of Node chat duration.
  602. ;   NODEMODE BUSY calculates Node chat duration and accounts for it
  603. ;       as 'busy' time (i.e. the system was in use during this time).
  604. ;   NODEMODE IDLE calculates Node chat duration and accounts for it
  605. ;       as 'idle' time (i.e. the system was NOT in use during this time).
  606. NODEMODE IDLE
  607.  
  608. This should be set to IDLE also for now as it has the same problem as above
  609. and was added just to be compatible with CHATMODE.
  610.  
  611. *---------------------------------------------------------------------------
  612. ;Enable filtering of Modem return data
  613. RINGFILTER ON
  614.  
  615. Sometimes the Modem returns more that just the baud rate in the way of line
  616. noise. This causes unusal reports. Also on some office phone systems it is
  617. posibble to get a double ring and a RING appears before the resulting in
  618. such entries as:
  619.  
  620.       Modem: CONNECT 2400 D D C C C
  621.       Modem: CONNECT 2400 ? ? ?
  622.       Modem: RING CONNECT 2400
  623.  
  624. which throws off the report. Setting RINGFILTER ON will cause the word RING
  625. to be filtered out of the line and the connect string will be truncated at
  626. the first space past the 'CONNECT XXXXX'.
  627.  
  628. *---------------------------------------------------------------------------
  629. ;Enable filtering of CONNECT from Modem return data - Default = OFF
  630. CONNECTFILTER ON
  631.  
  632. Some modems return much longer Connect strings and CALLS truncates the string
  633. making it less readable. Setting CONNECTFILTER to ON causes the word CONNECT
  634. to be eliminated from the string, allowing more room for useful text. If the
  635. string contains only the word CONNECT then it will not be removed (or else it
  636. will cause a problem with the CALLS.SAV file being read back in due to the
  637. blank line, which is normally means the end of a list has been reached.) If
  638. you have a CALLS.SAV file and do not want to regenerate it, you can edit out
  639. the CONNECT portion of the string manually (but don't elminate it on the
  640. string containing only CONNECT as mentioned above, causing a blank line)
  641. If the Connect string contains a CARRIER and a CONNECT then if CONNECTFILTER
  642. is active, the CARRIER will be filtered out and the entire CONNECT XXXXX will
  643. be filtered out.
  644.  
  645. ==============================================================================
  646. Of course, despite the fact that the title screen still says support is from
  647. Samuel H. Smith, please don't refer questions regarding features added in this
  648. version to him. I will field all support questions for the changes I made.
  649.  
  650.                                                                 Gary Meeker
  651.